/*
 *  Copyright (C) 2010 Glauco
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.balisunrise.nbpam.windows;

import javax.swing.JDialog;
import org.balisunrise.common.VisualEntity;

/**
 * Interface auxiliar para dos Dialogs poderem ser utilizados pela
 * View.
 *
 * @author Glauco
 * @see org.balisunrise.swing.transaction.view.View
 */
public interface DialogView {

    /**
     * Representação Visual. O próprio Dialog.
     * @return
     */
    public JDialog getVisualRepresentation();

    /**
     * Retorna a VisualEntity desta View.
     * @return
     */
    public VisualEntity getVisualEntity();

    /**
     * Algumas View podem retornar ao confirmar ou cancelar, se for uma destas
     * é retornado um objeto Boolean informando se foi confirmado.
     * Quando as View não retornam ao confirmar, é retornado nulo.
     *
     * @return <code>true</code> se foi confirmada a View, <code>false</code>
     * caso contrário e <code>null</code> caso a confirmação da View não
     * termina a exibição.
     */
    public Boolean getConfirmation();

    /**
     * Exibe a View.
     * @param visible se é para exibir a View.
     */
    public void setVisible(boolean visible);
}
